home *** CD-ROM | disk | FTP | other *** search
/ Games of Daze / Infomagic - Games of Daze (Summer 1995) (Disc 1 of 2).iso / djgpp / contrib / pdcurs22 / src / portable / addch.c next >
Encoding:
C/C++ Source or Header  |  1995-01-26  |  7.2 KB  |  199 lines
  1. /*
  2. ***************************************************************************
  3. * This file comprises part of PDCurses. PDCurses is Public Domain software.
  4. * You may use this code for whatever purposes you desire. This software
  5. * is provided AS IS with NO WARRANTY whatsoever.
  6. * Should this software be used in another application, an acknowledgement
  7. * that PDCurses code is used would be appreciated, but is not mandatory.
  8. *
  9. * Any changes which you make to this software which may improve or enhance
  10. * it, should be forwarded to the current maintainer for the benefit of 
  11. * other users.
  12. *
  13. * The only restriction placed on this code is that no distribution of
  14. * modified PDCurses code be made under the PDCurses name, by anyone
  15. * other than the current maintainer.
  16. * 
  17. * See the file maintain.er for details of the current maintainer.
  18. ***************************************************************************
  19. */
  20. #define    CURSES_LIBRARY    1
  21. #include <curses.h>
  22.  
  23. /* undefine any macros for functions defined in this module */
  24. #undef    addch
  25. #undef    waddch
  26. #undef    mvaddch
  27. #undef    mvwaddch
  28. #undef    echochar
  29. #undef    wechochar
  30.  
  31. /* undefine any macros for functions called by this module if in debug mode */
  32. #ifdef PDCDEBUG
  33. #  undef    refresh
  34. #  undef    wrefresh
  35. #  undef    move
  36. #  undef    wmove
  37. #endif
  38.  
  39. #ifdef PDCDEBUG
  40. char *rcsid_addch  = "$Id$";
  41. #endif
  42.  
  43. /*man-start*********************************************************************
  44.  
  45.   Name:                                                         addch
  46.  
  47.   Synopsis:
  48.       int addch(chtype ch);
  49.       int waddch(WINDOW *win, chtype ch);
  50.       int mvaddch(int y, int x, chtype ch);
  51.       int mvwaddch(WINDOW *win, int y, int x, chtype ch);
  52.       int echochar(chtype ch);
  53.       int wechochar(WINDOW *win, chtype ch);
  54.  
  55.   X/Open Description:
  56.      The routine addch() inserts the character ch into the default
  57.      window at the current cursor position and the window cursor is
  58.      advanced.  The character is of the type chtype as containing
  59.      both data and attributes.
  60.  
  61.      The routine waddch() inserts the character ch into the specified
  62.      window at the current cursor position.  The cursor position is
  63.      advanced.
  64.  
  65.      The routine mvaddch() moves the cursor to the specified (y, x)
  66.      position and inserts the character ch into the default window.
  67.      The cursor position is advanced after the character has been
  68.      inserted.
  69.  
  70.      The routine mvwaddch() moves the cursor to the specified (y, x)
  71.      position and inserts the character ch into the specified
  72.      window.  The cursor position is advanced after the character
  73.      has been inserted.
  74.  
  75.      The routine echochar() inserts the character ch into stdscr
  76.      at the current cursor position and a refresh() is called.  
  77.      The cursor position is advanced.
  78.  
  79.      The routine wechochar() inserts the character ch into the
  80.      specified window at the current cursor position and a wrefresh() 
  81.      is called. The cursor position is advanced.
  82.  
  83.      All these routines are similar to putchar().  The following
  84.      information applies to all the routines.
  85.  
  86.      If the cursor moves on to the right margin, an automatic
  87.      newline is performed.  If scrollok is enabled, and a character
  88.      is added to the bottom right corner of the screen, the
  89.      scrolling region will be scrolled up one line.  If scrolling
  90.      is not allowed, ERR will be returned.
  91.  
  92.      If ch is a tab, newline, or backspace, the cursor will be
  93.      moved appropriately within the window.  If ch is a newline,
  94.      the clrtoeol routine is called before the cursor is moved to
  95.      the beginning of the next line.  If newline mapping is off,
  96.      the cursor will be moved to the next line, but the x
  97.      coordinate will be unchanged.  If ch is a tab the cursor is
  98.      moved to the next tab position within the window.  If ch is
  99.      another control character, it will be drawn in the ^X
  100.      notation.  Calling the inch() routine after adding a control
  101.      character returns the representation of the control character,
  102.      not the control character.
  103.  
  104.      Video attributes can be combined with a character by ORing
  105.      them into the parameter.  This will result in these attributes
  106.      being set.  The intent here is that text, including
  107.      attributes, can be copied from one place to another using inch()
  108.      and addch().
  109.  
  110.      NOTE: All these functions are implemented as macros.
  111.  
  112.   PDCurses Description:
  113.      Depending upon the state of the raw character output, 7- or
  114.      8-bit characters will be output.
  115.  
  116.   X/Open Return Value:
  117.      All functions return OK on success and ERR on error.
  118.  
  119.   X/Open Errors:
  120.      No errors are defined for this function.
  121.  
  122.   Portability                             X/Open    BSD    SYS V
  123.                                           Dec '88
  124.       addch                                 Y        Y       Y
  125.       waddch                                Y        Y       Y
  126.       mvaddch                               Y        Y       Y
  127.       mvwaddch                              Y        Y       Y
  128.       echochar                              -        -      3.0
  129.       wechochar                             -        -      3.0
  130.  
  131. **man-end**********************************************************************/
  132.  
  133. /***********************************************************************/
  134. int    addch(chtype ch)
  135. /***********************************************************************/
  136. {
  137. #ifdef PDCDEBUG
  138.     if (trace_on) PDC_debug("addch() - called\n");
  139. #endif
  140.  
  141.     return( PDC_chadd( stdscr, ch, (bool)(!(_cursvar.raw_out)), TRUE ) );
  142. }
  143. /***********************************************************************/
  144. int    waddch(WINDOW *win, chtype ch)
  145. /***********************************************************************/
  146. {
  147. #ifdef PDCDEBUG
  148.     if (trace_on) PDC_debug("waddch() - called\n");
  149. #endif
  150.  
  151.     return( PDC_chadd( win, ch, (bool)(!(_cursvar.raw_out)), TRUE ) );
  152. }
  153. /***********************************************************************/
  154. int    mvaddch(int y, int x, chtype ch)
  155. /***********************************************************************/
  156. {
  157. #ifdef PDCDEBUG
  158.     if (trace_on) PDC_debug("mvaddch() - called\n");
  159. #endif
  160.     if (move(y,x) == ERR)
  161.         return(ERR);
  162.     return( PDC_chadd( stdscr, ch, (bool)(!(_cursvar.raw_out)), TRUE ) );
  163. }
  164. /***********************************************************************/
  165. int    mvwaddch(WINDOW *win, int y, int x, chtype ch)
  166. /***********************************************************************/
  167. {
  168. #ifdef PDCDEBUG
  169.     if (trace_on) PDC_debug("mvwaddch() - called\n");
  170. #endif
  171.     if (wmove(win,y,x) == ERR)
  172.         return(ERR);
  173.     return( PDC_chadd( win, ch, (bool)(!(_cursvar.raw_out)), TRUE ) );
  174. }
  175. /***********************************************************************/
  176. int    echochar(chtype ch)
  177. /***********************************************************************/
  178. {
  179. #ifdef PDCDEBUG
  180.     if (trace_on) PDC_debug("echochar() - called\n");
  181. #endif
  182.  
  183.     if (PDC_chadd( stdscr, ch, (bool)(!(_cursvar.raw_out)), TRUE ) == ERR)
  184.         return(ERR);
  185.     return(refresh());
  186. }
  187. /***********************************************************************/
  188. int    wechochar(WINDOW *win, chtype ch)
  189. /***********************************************************************/
  190. {
  191. #ifdef PDCDEBUG
  192.     if (trace_on) PDC_debug("wechochar() - called\n");
  193. #endif
  194.  
  195.     if (PDC_chadd( win, ch, (bool)(!(_cursvar.raw_out)), TRUE ) == ERR)
  196.         return(ERR);
  197.     return(wrefresh(win));
  198. }
  199.